Vcenter Network FilterSpec

The Vcenter Network FilterSpec schema contains properties used to filter the results when listing networks (see GET /vcenter/network). If multiple properties are specified, only networks matching all of the properties match the filter.

JSON Example

{
    "networks": [
        "string"
    ],
    "names": [
        "string"
    ],
    "types": [
        "string"
    ],
    "folders": [
        "string"
    ],
    "datacenters": [
        "string"
    ]
}

array of string

networks

Optional

Identifiers of networks that can match the filter.

If missing or null or empty, networks with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Network. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Network.

array of string

names

Optional

Names that networks must have to match the filter (see Vcenter Network Summary.name).

If missing or null or empty, networks with any name match the filter.

array of string

types

Optional

Types that networks must have to match the filter (see Vcenter Network Summary.type).

For more information see: Vcenter Network Type.

If missing or null, networks with any type match the filter.

array of string

folders

Optional

Folders that must contain the network for the network to match the filter.

If missing or null or empty, networks in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

array of string

datacenters

Optional

Datacenters that must contain the network for the network to match the filter.

If missing or null or empty, networks in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.